Skip to content

docs: three-ways-to-learn guide + prune stale API-doc references#593

Merged
Jammy2211 merged 1 commit into
mainfrom
feature/release-docs-polish-learn-paths
Jul 9, 2026
Merged

docs: three-ways-to-learn guide + prune stale API-doc references#593
Jammy2211 merged 1 commit into
mainfrom
feature/release-docs-polish-learn-paths

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

Summary

Phase C + Phase A of the release-docs polish (#592).

  • Phase C — Three Ways to Learn: adds a "Three Ways to Learn PyAutoLens" subsection (manual navigation / AI chat assistant / fully agentic AI) to overview_2_new_user_guide.md, and reframes autolens_assistant from "experimental / not recommended" to a first-class option in README.md + docs/index.md.
  • Phase A — API-doc cleanup: prunes docs/api/*.rst autosummary entries for removed API — the OO plotting subsystem (MatPlot2D/Cmap/*Scatter, replaced by the functional plot API), PySwarms*, PointDict, SetupAdaptAdaptImages, OverSamplingOverSampler, and dead linear Chameleon entries (kept correctly under light_and_mass_profiles). Re-audit reports zero broken/missing/duplicate references.

The positive functional-API plot.rst rewrite is filed as a follow-up (PyAutoMind docs/autolens/plot_rst_functional_api_rewrite.md).

Validation checklist (--auto, supervised)

  • Tests: n/a — zero Python source changed (only docs/*.rst, docs/*.md, README.md); no public-API/downstream surface.
  • Smoke: n/a — no downstream script surface in this repo's diff.
  • Review: CLEAN — review-faculty surface; re-audit confirms every autosummary reference resolves against the installed stack; CRLF preserved (byte-safe edits).
  • Heart: YELLOW — reason set human-acknowledged at ship (5 chronic organism reasons: stale workspace-validation, 58 parked scripts, assistant pin-behind, 3 timing regressions, 10d-old Mind PR; none from this change, none RED).

Autonomous run ended at PR-open; merge stays human. Library-first gate: merge this + PyAutoGalaxy before the autolens_workspace PR.

Closes-part-of #592.

🤖 Generated with Claude Code

Phase C: add a 'Three Ways to Learn PyAutoLens' subsection (manual
navigation / AI chat assistant / fully agentic AI) to the new-user guide
and README; reframe autolens_assistant from experimental to a first-class
option in README + docs/index.

Phase A: prune docs/api/*.rst references to removed API — the OO plotting
subsystem (MatPlot2D/Cmap/*Scatter, replaced by the functional plot API),
PySwarms searches, PointDict, SetupAdapt->AdaptImages, OverSampling->
OverSampler, and dead linear Chameleon entries. Re-audit clean.

Issue #592.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@Jammy2211 Jammy2211 added the pending-release PR queued for the next release build label Jul 9, 2026
@Jammy2211 Jammy2211 merged commit da863a3 into main Jul 9, 2026
4 checks passed
@Jammy2211 Jammy2211 deleted the feature/release-docs-polish-learn-paths branch July 9, 2026 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pending-release PR queued for the next release build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant